home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cato / Xm / XmStringDrawUnderline.z / XmStringDrawUnderline
Text File  |  1998-10-20  |  7KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDrrrraaaawwwwUUUUnnnnddddeeeerrrrlllliiiinnnneeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDrrrraaaawwwwUUUUnnnnddddeeeerrrrlllliiiinnnneeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDrrrraaaawwwwUUUUnnnnddddeeeerrrrlllliiiinnnneeee - A compound string function that
  10.           underlines a string drawn in an X Window
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>>
  14.  
  15.           vvvvooooiiiidddd XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDrrrraaaawwwwUUUUnnnnddddeeeerrrrlllliiiinnnneeee ((((_d, _w, _f_o_n_t_l_i_s_t, _s_t_r_i_n_g, _g_c, _x, _y, _w_i_d_t_h, _a_l_i_g_n_m_e_n_t, _l_a_y_o_u_t__d_i_r_e_c_t_i_o_n, _c_l_i_p, _u_n_d_e_r_l_i_n_e))))
  16.                DDDDiiiissssppppllllaaaayyyy   * _d;;;;
  17.                WWWWiiiinnnnddddoooowwww    _w;;;;
  18.                XXXXmmmmFFFFoooonnnnttttLLLLiiiisssstttt_f_o_n_t_l_i_s_t;;;;
  19.                XXXXmmmmSSSSttttrrrriiiinnnngggg  _s_t_r_i_n_g;;;;
  20.                GGGGCCCC        _g_c;;;;
  21.                PPPPoooossssiiiittttiiiioooonnnn  _x;;;;
  22.                PPPPoooossssiiiittttiiiioooonnnn  _y;;;;
  23.                DDDDiiiimmmmeeeennnnssssiiiioooonnnn _w_i_d_t_h;;;;
  24.                uuuunnnnssssiiiiggggnnnneeeedddd cccchhhhaaaarrrr_a_l_i_g_n_m_e_n_t;;;;
  25.                uuuunnnnssssiiiiggggnnnneeeedddd cccchhhhaaaarrrr_l_a_y_o_u_t__d_i_r_e_c_t_i_o_n;;;;
  26.                XXXXRRRReeeeccccttttaaaannnngggglllleeee* _c_l_i_p;;;;
  27.                XXXXmmmmSSSSttttrrrriiiinnnngggg  _u_n_d_e_r_l_i_n_e;;;;
  28.  
  29.  
  30.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  31.           This page documents version 1.2 of the Motif library.
  32.  
  33.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  34.           XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDrrrraaaawwwwUUUUnnnnddddeeeerrrrlllliiiinnnneeee draws a compound string in an X
  35.           Window.  If the substring identified by _u_n_d_e_r_l_i_n_e can be
  36.           matched in _s_t_r_i_n_g, the substring will be underlined.  Once a
  37.           match has occurred, no further matches or underlining will
  38.           be done.
  39.  
  40.           If a compound string segment uses a font list entry that
  41.           defines a font set, the graphic context passed to this
  42.           routine will have the GC font member left in an undefined
  43.           state.  The underlying XXXXmmmmbbbbSSSSttttrrrriiiinnnnggggDDDDrrrraaaawwww function called by this
  44.           routine modifies the font id field of the GC passed into it
  45.           and does not attempt to restore the font id to the incoming
  46.           value.  If the compound string segment is not drawn using a
  47.           font set, the graphic context must contain a valid font
  48.           member.  Graphic contexts created by XXXXttttGGGGeeeettttGGGGCCCC are not
  49.           accepted by this routine; instead, use XXXXttttAAAAllllllllooooccccaaaatttteeeeGGGGCCCC to
  50.           create a graphic context.
  51.  
  52.  
  53.           _d           Specifies the display.
  54.  
  55.           _w           Specifies the window.
  56.  
  57.           _f_o_n_t_l_i_s_t    Specifies the font list.
  58.  
  59.           _s_t_r_i_n_g      Specifies the string.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDrrrraaaawwwwUUUUnnnnddddeeeerrrrlllliiiinnnneeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDrrrraaaawwwwUUUUnnnnddddeeeerrrrlllliiiinnnneeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           _g_c          Specifies the graphics context to use.
  75.  
  76.           _x           Specifies a coordinate of the rectangle that
  77.                       will contain the displayed compound string.
  78.  
  79.           _y           Specifies a coordinate of the rectangle that
  80.                       will contain the displayed compound string.
  81.  
  82.           _w_i_d_t_h       Specifies the width of the rectangle that will
  83.                       contain the displayed compound string.
  84.  
  85.           _a_l_i_g_n_m_e_n_t   Specifies how the string will be aligned within
  86.                       the specified rectangle.  It is one of
  87.                       XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBEEEEGGGGIIIINNNNNNNNIIIINNNNGGGG, XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCEEEENNNNTTTTEEEERRRR, or
  88.                       XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____EEEENNNNDDDD.
  89.  
  90.           _l_a_y_o_u_t__d_i_r_e_c_t_i_o_n
  91.                       Controls the direction in which the segments of
  92.                       the compound string will be laid out.  It also
  93.                       determines the meaning of the _a_l_i_g_n_m_e_n_t
  94.                       parameter.
  95.  
  96.           _c_l_i_p        Allows the application to restrict the area into
  97.                       which the compound string will be drawn.  If
  98.                       NULL, no clipping will be done.
  99.  
  100.           _u_n_d_e_r_l_i_n_e   Specifies the substring to be underlined.
  101.  
  102.  
  103.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  104.           XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCrrrreeeeaaaatttteeee((((3333XXXX)))).
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.